Balance Overview Report Templates

CygNet Measurement > Using CygNet Measurement > Reports > Report Template Files > Balance Overview

Balance Overview Report Templates

Balance Overview report templates contain a ReportDefinition page and a ReportSheet page, to access the worksheets that together describe the reports you can produce. CygNet provides a sample report template file BalanceOverviewTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.

The ReportDefinition sheet includes the following parameters to describe the type of report to build.

ReportParameters
Worksheet

The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.

Header
SubReport Header
Data Table Header
Data Table
SubReport Footer
Report Footer

Displaying Additional (Non-Token) Values

You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.

Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.

Example

[Volume_In] is a valid token. If you use [Vol_In] (not a valid token) instead of [Volume_In], the value will be displayed as "[Vol_In]" instead of displaying the volume value desired, since [Vol_In] is not a valid token.

[Vol_In]

Configuring the ReportDefinition

The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.

Balance Overview Report: ReportParameters

Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportName	The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.	This value is used to specify the report name. Example Balance Overview
CommandName	The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information.	This value is used to specify the report command name. Example BALO Note: Maximum of 7 characters; letters or numbers only, no spaces.

Parameter

Description

Value

ReportName

The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer.

See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.

This value is used to specify the report name.

Example

Balance Overview

CommandName

The value defined in this cell will be used by the service to determine which specific report command type to execute.

See FMSClient Methods in the Scripting section for more information.

This value is used to specify the report command name.

Example

BALO

Note: Maximum of 7 characters; letters or numbers only, no spaces.

Balance Overview Report: Worksheet Parameters

Balance Overview report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportType	The value defined in this cell is used to represent the standard FMS report type you are configuring.	This value is used along with NodeResolutionMethod to indicate the type of report to build. Example Balance
NodeResolutionMethod	The value defined in this cell is used to represent the method used to resolve which Nodes are shown in the report.	This value is used along with ReportType to indicate the type of report to build. Example Command
RecordSpan	The value defined in this cell will be used to specify the record span format for the report.	Enter one of the following options. Hour Day Month This parameter is required.
PageBreaks	The value defined in this cell will be used to specify whether or not to use page breaks in your report. If used, will force a page break after each station (or liquid device Node).	Enter a value to indicate whether or not to insert page breaks. Options are Yes or No. Default value is Yes.
NodeSortOrder	The value defined in this cell will be used to specify the order in which to display Node results in the report.	Enter one of the following options. Name ascending Description ascending Name descending Description descending Default value is Name ascending. This parameter is optional.

Configuring the ReportSheet

The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.

Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.

Balance Overview Report: Header Tokens

Balance Overview report headers, which appear above #EndReportHdr#, can be described by the following tokens.

Token	Description
[CmdGroupName]	The name of the group Node against which the command was run.
[CmdGroupDesc]	The description of the group Node against which the command was run.
[GeneratedDateTime]	The time the report was generated, in Local time (L)
[TotalStationCount]	The total number of stations (or liquid device Nodes) in the report

Balance Overview Report: SubReport Header Tokens

Balance Overview report subreport headers, which appear between #SubSection# SubReportHeader and #End#, can be described by the following tokens.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
[CurrentStationCount]	The index of the station (or liquid device Node) being displayed
[TotalStationCount]	The total number of stations (or liquid device Nodes) in the report
[NodeName]	The Node name
[NodeDescription]	The Node description
[NodeSecurityApp]	The security application of the Node
[NodeSortPriority]	The sort priority of the Node
[NodeStationContribution]	For Station Group Nodes, the station contribution value, whether receipt (+) or delivery (-)
[NodeType]	The Node type
Units Tokens
[Energy_Units]	The units used for Energy data
[Volume_Units]	The units used for Volume data
[Mass_Units]	The units used for Mass data

Balance Overview Report: Data Table Header Tokens

Balance Overview report data table headers, which appear between #SubSection# DataTableHeader and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[RowNumber]	The current row number
[Energy_Units]	The units used for Energy data
[Volume_Units]	The units used for Volume data
[Mass_Units]	The units used for Mass data

Balance Overview Report: Data Table Tokens

Note: Energy and Volume data cell values have meaning according to the Node type selected, as follows:

Energy values apply for Gas Nodes only; they do not apply for Liquid Nodes.
Volume values for Liquid Nodes are calculated Gas Equivalent Volume (GEV), in accordance with Directive 017. Refer to Appendix 5: Gas Equivalent Volume Determination for more information.

Balance Overview report data table parameters, which appear between #SubSection# DataTable (1 or 2) and #End#, can be described by the following tokens.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
[BeginDateTime]	The start date, in Contract day (C), of the time range for the record
[EndDateTime]	The end date, in Contract day (C), of the time range for the record
[FirstRow]	The row number of the first row in the data table
[RowNumber]	The current row number
Balance Tokens
[Avg_Acceptability]	The numerical percentage value indicating the relative validity of the data
[Energy_In]	The incoming energy
[Energy_Out]	The outgoing energy
[Energy_Net]	The net energy gain/loss
[Energy_Change]	The change in energy
[Volume_In]	The incoming volume
[Volume_Out]	The outgoing volume
[Volume_Net]	The net volume gain/loss
[Volume_Change]	The change in volume
[Mass_In]	The incoming mass
[Mass_Out]	The outgoing mass
[Mass_Net]	The net mass gain/loss
[Mass_Change]	The change in mass

Balance Overview Report: SubReport Footer Tokens

Balance Overview report subreport footers, which appear between #SubSection# SubReportFooter and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[LastRow]	The row number of the last row in the data table
[CurrentStationCount]	The index of the station (or liquid device Node) being displayed
[TotalStationCount]	The total number of stations (or liquid device Nodes) in the report
[NodeName]	The Node name
[NodeDescription]	The Node description
[NodeSecurityApp]	The security application of the Node
[NodeSortPriority]	The sort priority of the Node
[NodeStationContribution]	For Station Group Nodes, the station contribution value, whether receipt (+) or delivery (-)
[NodeType]	The Node type

Balance Overview Report: Report Footer

Balance Overview report footers, which appear between #SubSection# ReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.